Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to continue a trace using baggage header #5617

Merged
merged 3 commits into from
Oct 11, 2022

Conversation

adinauer
Copy link
Member

@adinauer adinauer commented Oct 7, 2022

For people who want to manually use distributed tracing via baggage header.

@adinauer adinauer requested a review from a team October 7, 2022 10:51
@vercel
Copy link

vercel bot commented Oct 7, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Oct 10, 2022 at 1:41PM (UTC)

TransactionNameSource.CUSTOM,
"op",
new SentryTraceHeader(sentryTrace),
Baggage.fromHeader(baggageHeaders, hub.getOptions().getLogger())
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to expose a method fromHeader that doesn't take a logger.
Sentry.getCurrentHub() is @ApiStatus.Internal so people cannot use this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or make it nullable, but I'd rather expose a new overload.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about passing in the options instead?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That does not help either, there's no public API to retrieve the options.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm so we're down to calling Sentry.getCurrentHub().getOptions().getLogger() inside then to hide it from the user but still be able to log problems I presume.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fine, that's what HubAdapter.getInstance() stands for, at least to make it testable when calling internally.
I'd make a PR asap because otherwise, it's not usable, I don't expect people using Baggage.fromHeader themselves any way, so it's not a p0 but create an issue, and don't merge this before doing it, this would just raise more questions around "how do I get the logger?".

Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made a couple wording edits

@adinauer adinauer marked this pull request as ready for review October 11, 2022 05:53
@adinauer adinauer merged commit 196d660 into master Oct 11, 2022
@adinauer adinauer deleted the feat/document-baggage-ds-continuation branch October 11, 2022 05:54
@github-actions github-actions bot locked and limited conversation to collaborators Oct 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants